expand guidelines README #934
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kyma-bot
added
the
do-not-merge/work-in-progress
|
Skipping CI for Draft Pull Request. |
kyma-bot
added
cla: yes
kyma-bot
added
size/M
kyma-bot
removed
the
do-not-merge/work-in-progress
IwonaLanger
reviewed
Sep 18, 2024
| @@ -22,7 +22,7 @@ This table lists all document types used to fully describe a Kyma area and/or co | |||
| | [`kyma/docs`](https://github.com/kyma-project/kyma/tree/main/docs) | [`architecture.md`](https://github.com/kyma-project/community/blob/main/templates/resources/architecture.md) | Use the template to describe the architecture of a Kyma component. | All contributors | | |||
| | [`kyma/docs`](https://github.com/kyma-project/kyma/tree/main/docs) | [`configuration.md`](https://github.com/kyma-project/community/blob/main/templates/resources/configuration.md) | Use the template to describe configuration options for a Kyma chart or sub-chart. | All contributors | | |||
| | [`kyma/docs`](https://github.com/kyma-project/kyma/tree/main/docs) | [`custom-resource.md`](https://github.com/kyma-project/community/blob/main/templates/resources/custom-resource.md) | Use the template to describe a custom resource (CR) and its elements. | All contributors | | |||
| | [`kyma/docs`](https://github.com/kyma-project/kyma/tree/main/docs) | [`tutorials.md`](https://github.com/kyma-project/community/blob/main/templates/resources/tutorial.md) | Use the template to provide a clear step-by-step instruction that helps the user to understand a given concept better. | All contributors | | |||
| | [`kyma/docs`](https://github.com/kyma-project/kyma/tree/main/docs) | [`tutorials.md`](https://github.com/kyma-project/community/blob/main/templates/resources/task.md) | Use the template to provide a clear step-by-step instruction that helps the user to understand a given concept better. | All contributors | | |||
There was a problem hiding this comment.
Suggested change
| | [`kyma/docs`](https://github.com/kyma-project/kyma/tree/main/docs) | [`tutorials.md`](https://github.com/kyma-project/community/blob/main/templates/resources/task.md) | Use the template to provide a clear step-by-step instruction that helps the user to understand a given concept better. | All contributors | | |
| | [`kyma/docs`](https://github.com/kyma-project/kyma/tree/main/docs) | [`task.md`](https://github.com/kyma-project/community/blob/main/templates/resources/task.md) | Use the template to provide a clear step-by-step instruction that helps the user to understand a given task better. | All contributors | |
There was a problem hiding this comment.
I wouldn't use "concept" in the description. I've replaced it with "task, but it could be "process" or "procedure".
There was a problem hiding this comment.
Good catch!
Thinking about it, we could probably stop the sentence after "instruction" :D
IwonaLanger
approved these changes
Sep 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Changes proposed in this pull request:
Related issue(s)